Clean up EntityMetaData and fix incorrect release tags #7034
+221
−136
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@khanaffan @ColinKerr @diegoalexdiaz please fact-check my documentation. |
pmconne
commented
Aug 2, 2024
pmconne
requested review from
diegoalexdiaz,
ColinKerr and
a team
as code owners
|
Can we take a look at how this stuff is actually used before we promote to public? |
We can, but I want to reiterate: it is already public and has been for years, beta tag notwithstanding. |
…s-core into pmc/entity-metadata
pmconne
changed the title
khanaffan
reviewed
Aug 6, 2024
|
This pull request is now in conflicts. Could you fix it @pmconne? 🙏 |
khanaffan
approved these changes
Aug 6, 2024
diegoalexdiaz
approved these changes
Aug 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Part of https://github.com/iTwin/itwinjs-backlog/issues/1103.
This was one of the very first APIs ever created for iTwin.js and boy does it show.
Despite still being tagged as
@betaafter all these years, it has always been de facto part of the@publicAPI due to its use in@publicmethods likeEntity.forEachPropertyandElement.getClassMetaData. (api-extractor does not check ae-incompatible-release-tags across package boundaries).I tried to do minimal cleanup without introducing breaking changes and add/clarify documentation. Mostly I preferred to link to the learning articles in docs/bis/ec; those need some separate cleanup, though.